Vcenter Host Summary

The Vcenter Host Summary schema contains commonly used information about a host in vCenter Server.

JSON Example

{
    "host": "string",
    "name": "string",
    "connection_state": "string",
    "power_state": "string",
    "host_uuid": "string"
}

string

host

Required

Identifier of the host.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem.

string

name

Required

Name of the host.

string

connection_state

Required

Connection status of the host

For more information see: Vcenter Host ConnectionState.

string

power_state

Optional

Power state of the host

For more information see: Vcenter Host PowerState.

This property is optional and it is only relevant when the value of connection_state is Vcenter Host ConnectionState.CONNECTED.

string

host_uuid

Optional

UUID of the host. Maps to "UUID" in SMBIOS: System Information (Type 1) and offset 08h

This property was added in vSphere API 9.0.0.0.

This property is optional because it was added in a newer version than its parent node.